home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 42 / Amiga Format AFCD42 (Issue 126, Aug 1999).iso / -serious- / comms / other / amivnc / rfbproto.h < prev    next >
Text File  |  1999-05-25  |  22KB  |  681 lines
  1. //  Copyright (C) 1997, 1998 Olivetti & Oracle Research Laboratory
  2. //
  3. //  This file is part of the VNC system.
  4. //
  5. //  The VNC system is free software; you can redistribute it and/or modify
  6. //  it under the terms of the GNU General Public License as published by
  7. //  the Free Software Foundation; either version 2 of the License, or
  8. //  (at your option) any later version.
  9. //
  10. //  This program is distributed in the hope that it will be useful,
  11. //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13. //  GNU General Public License for more details.
  14. //
  15. //  You should have received a copy of the GNU General Public License
  16. //  along with this program; if not, write to the Free Software
  17. //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,
  18. //  USA.
  19. //
  20. // If the source code for the VNC system is not available from the place 
  21. // whence you received this file, check http://www.orl.co.uk/vnc or contact
  22. // the authors on vnc@orl.co.uk for information on obtaining it.
  23.  
  24.  
  25. /*
  26.  * rfbproto.h - header file for the RFB protocol version 3.3
  27.  *
  28.  * Uses types CARD<n> for an n-bit unsigned integer, INT<n> for an n-bit signed
  29.  * integer (for n = 8, 16 and 32).
  30.  *
  31.  * All multiple byte integers are in big endian (network) order (most
  32.  * significant byte first).  Unless noted otherwise there is no special
  33.  * alignment of protocol structures.
  34.  *
  35.  *
  36.  * Once the initial handshaking is done, all messages start with a type byte,
  37.  * (usually) followed by message-specific data.  The order of definitions in
  38.  * this file is as follows:
  39.  *
  40.  *  (1) Structures used in several types of message.
  41.  *  (2) Structures used in the initial handshaking.
  42.  *  (3) Message types.
  43.  *  (4) Encoding types.
  44.  *  (5) For each message type, the form of the data following the type byte.
  45.  *      Sometimes this is defined by a single structure but the more complex
  46.  *      messages have to be explained by comments.
  47.  */
  48.  
  49.  
  50. /*****************************************************************************
  51.  *
  52.  * Structures used in several messages
  53.  *
  54.  *****************************************************************************/
  55.  
  56. /*-----------------------------------------------------------------------------
  57.  * Structure used to specify a rectangle.  This structure is a multiple of 4
  58.  * bytes so that it can be interspersed with 32-bit pixel data without
  59.  * affecting alignment.
  60.  */
  61.  
  62. #define CARD8 unsigned char
  63. #define CARD16 unsigned short
  64. #define CARD32 unsigned long
  65.  
  66. typedef struct {
  67.     CARD16 x;
  68.     CARD16 y;
  69.     CARD16 w;
  70.     CARD16 h;
  71. } rfbRectangle;
  72.  
  73. #define sz_rfbRectangle 8
  74.  
  75.  
  76. /*-----------------------------------------------------------------------------
  77.  * Structure used to specify pixel format.
  78.  */
  79.  
  80. typedef struct {
  81.  
  82.     CARD8 bitsPerPixel;        /* 8,16,32 only */
  83.  
  84.     CARD8 depth;        /* 8 to 32 */
  85.  
  86.     CARD8 bigEndian;        /* True if multi-byte pixels are interpreted
  87.                    as big endian, or if single-bit-per-pixel
  88.                    has most significant bit of the byte
  89.                    corresponding to first (leftmost) pixel. Of
  90.                    course this is meaningless for 8 bits/pix */
  91.  
  92.     CARD8 trueColour;        /* If false then we need a "colour map" to
  93.                    convert pixels to RGB.  If true, xxxMax and
  94.                    xxxShift specify bits used for red, green
  95.                    and blue */
  96.  
  97.     /* the following fields are only meaningful if trueColour is true */
  98.  
  99.     CARD16 redMax;        /* maximum red value (= 2^n - 1 where n is the
  100.                    number of bits used for red). Note this
  101.                    value is always in big endian order. */
  102.  
  103.     CARD16 greenMax;        /* similar for green */
  104.  
  105.     CARD16 blueMax;        /* and blue */
  106.  
  107.     CARD8 redShift;        /* number of shifts needed to get the red
  108.                    value in a pixel to the least significant
  109.                    bit. To find the red value from a given
  110.                    pixel, do the following:
  111.                    1) Swap pixel value according to bigEndian
  112.                       (e.g. if bigEndian is false and host byte
  113.                       order is big endian, then swap).
  114.                    2) Shift right by redShift.
  115.                    3) AND with redMax (in host byte order).
  116.                    4) You now have the red value between 0 and
  117.                       redMax. */
  118.  
  119.     CARD8 greenShift;        /* similar for green */
  120.  
  121.     CARD8 blueShift;        /* and blue */
  122.  
  123.     CARD8 pad1;
  124.     CARD16 pad2;
  125.  
  126. } rfbPixelFormat;
  127.  
  128. #define sz_rfbPixelFormat 16
  129.  
  130.  
  131.  
  132. /*****************************************************************************
  133.  *
  134.  * Initial handshaking messages
  135.  *
  136.  *****************************************************************************/
  137.  
  138. /*-----------------------------------------------------------------------------
  139.  * Protocol Version
  140.  *
  141.  * The server always sends 12 bytes to start which identifies the latest RFB
  142.  * protocol version number which it supports.  These bytes are interpreted
  143.  * as a string of 12 ASCII characters in the format "RFB xxx.yyy\n" where
  144.  * xxx and yyy are the major and minor version numbers (for version 3.3
  145.  * this is "RFB 003.003\n").
  146.  *
  147.  * The client then replies with a similar 12-byte message giving the version
  148.  * number of the protocol which should actually be used (which may be different
  149.  * to that quoted by the server).
  150.  *
  151.  * It is intended that both clients and servers may provide some level of
  152.  * backwards compatibility by this mechanism.  Servers in particular should
  153.  * attempt to provide backwards compatibility, and even forwards compatibility
  154.  * to some extent.  For example if a client demands version 3.1 of the
  155.  * protocol, a 3.0 server can probably assume that by ignoring requests for
  156.  * encoding types it doesn't understand, everything will still work OK.  This
  157.  * will probably not be the case for changes in the major version number.
  158.  *
  159.  * The format string below can be used in sprintf or sscanf to generate or
  160.  * decode the version string respectively.
  161.  */
  162.  
  163. #define rfbProtocolVersionFormat "RFB %03d.%03d\n"
  164. #define rfbProtocolMajorVersion 3
  165. #define rfbProtocolMinorVersion 3
  166.  
  167. typedef char rfbProtocolVersionMsg[13];    /* allow extra byte for null */
  168.  
  169. #define sz_rfbProtocolVersionMsg 12
  170.  
  171.  
  172. /*-----------------------------------------------------------------------------
  173.  * Authentication
  174.  *
  175.  * Once the protocol version has been decided, the server then sends a 32-bit
  176.  * word indicating whether any authentication is needed on the connection.
  177.  * The value of this word determines the authentication scheme in use.  For
  178.  * version 3.0 of the protocol this may have one of the following values:
  179.  */
  180.  
  181. #define rfbConnFailed 0
  182. #define rfbNoAuth 1
  183. #define rfbVncAuth 2
  184.  
  185. /*
  186.  * rfbConnFailed:    For some reason the connection failed (e.g. the server
  187.  *            cannot support the desired protocol version).  This is
  188.  *            followed by a string describing the reason (where a
  189.  *            string is specified as a 32-bit length followed by that
  190.  *            many ASCII characters).
  191.  *
  192.  * rfbNoAuth:        No authentication is needed.
  193.  *
  194.  * rfbVncAuth:        The VNC authentication scheme is to be used.  A 16-byte
  195.  *            challenge follows, which the client encrypts as
  196.  *            appropriate using the password and sends the resulting
  197.  *            16-byte response.  If the response is correct, the
  198.  *            server sends the 32-bit word rfbVncAuthOK.  If a simple
  199.  *            failure happens, the server sends rfbVncAuthFailed and
  200.  *            closes the connection. If the server decides that too
  201.  *            many failures have occurred, it sends rfbVncAuthTooMany
  202.  *            and closes the connection.  In the latter case, the
  203.  *            server should not allow an immediate reconnection by
  204.  *            the client.
  205.  */
  206.  
  207. #define rfbVncAuthOK 0
  208. #define rfbVncAuthFailed 1
  209. #define rfbVncAuthTooMany 2
  210.  
  211.  
  212. /*-----------------------------------------------------------------------------
  213.  * Client Initialisation Message
  214.  *
  215.  * Once the client and server are sure that they're happy to talk to one
  216.  * another, the client sends an initialisation message.  At present this
  217.  * message only consists of a boolean indicating whether the server should try
  218.  * to share the desktop by leaving other clients connected, or give exclusive
  219.  * access to this client by disconnecting all other clients.
  220.  */
  221.  
  222. typedef struct {
  223.     CARD8 shared;
  224. } rfbClientInitMsg;
  225.  
  226. #define sz_rfbClientInitMsg 1
  227.  
  228.  
  229. /*-----------------------------------------------------------------------------
  230.  * Server In